Skip to main content

Update Settlement Account

PATCH /api/v1/tenants/{tenantId}/settlement-account

Description​

Update the settlement account details for a tenant.

Path Parameters​

NameTypeDescription
tenantIdstringThe tenant ID (path)

Request Body​

  • Content Type: application/json
{
  "userId": "string",
  "bankName": "string",
  "bankCode": "string",
  "accountName": "string",
  "accountNumber": "string",
  "actionBy": "string",
  "allowWithoutWallet": false
}

Response Code: 200 - OK​

Description

Settlement account updated successfully.

Response Fields​

FieldTypeDescription
statusbooleanIndicates if the operation was successful
statusCodeintegerStatus code
messagestringResponse message
dataobjectData related to the updated settlement account
errorsarrayList of error messages, if any

Example​

{
  "status": true,
  "statusCode": 0,
  "message": "Settlement account updated successfully",
  "data": {},
  "errors": [
    {
      "message": "Some error occurred",
      "descriptiveMessage": "Detailed error message"
    }
  ]
}

Headers​

Content-TypeValue
apiKey{{apiKey}}

🔑 Authentication bearer​

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PATCH \ 
 --url  /api/v1/tenants/{tenantId}/settlement-account \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!